@chassdev/client-sdk 2.46.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Twenty.com, PBC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,47 @@
+<div align="center">
+  <h1>Chass Client SDK</h1>
+
+<a href="https://www.npmjs.com/package/@chassdev/client-sdk"><img alt="NPM version" src="https://img.shields.io/npm/v/@chassdev/client-sdk.svg?style=for-the-badge&labelColor=000000"></a>
+
+</div>
+
+Typed API clients for applications that extend [Chass](https://chass.app): a Core client for workspace records, a Metadata client for the data model, and a REST client.
+
+## Installation
+
+Apps import this package as `twenty-client-sdk`, so install it under that name, on the same version as `twenty-sdk`:
+
+```bash
+yarn add -D twenty-client-sdk@npm:@chassdev/client-sdk twenty-sdk@npm:@chassdev/sdk
+```
+
+Projects scaffolded with [create-chass-app](https://www.npmjs.com/package/create-chass-app) already include it.
+
+## Usage
+
+```ts
+import { CoreApiClient } from 'twenty-client-sdk/core';
+
+const client = new CoreApiClient();
+
+const { companies } = await client.query({
+  companies: { edges: { node: { id: true, name: true } } },
+});
+```
+
+| Entry point                  | Contents                                                      |
+| ---------------------------- | ------------------------------------------------------------- |
+| `twenty-client-sdk/core`     | `CoreApiClient`, typed from your workspace schema             |
+| `twenty-client-sdk/metadata` | `MetadataApiClient` for objects, fields, and other metadata   |
+| `twenty-client-sdk/rest`     | `RestApiClient` for the REST API                              |
+| `twenty-client-sdk/generate` | Client generation helpers used by the `chass` CLI             |
+
+`yarn chass dev` regenerates the Core client from your workspace schema whenever the data model changes, so its types follow your objects and fields.
+
+## Documentation
+
+See the [Chass apps documentation](https://docs.chass.app/developers/extend/apps/getting-started) for logic functions, front components, and the CLI.
+
+## License
+
+The Chass Client SDK is released under the MIT license. The full text ships in the package's `LICENSE` file.